/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2013-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.grizzly;

import java.io.IOException;

/**
 * An object, describing the reason why {@link Connection} was closed.
 * 
 * @author Alexey Stashok
 */
public class CloseReason {
    private static final IOException LOCALLY_CLOSED;
    private static final IOException REMOTELY_CLOSED;
    
    public static final CloseReason LOCALLY_CLOSED_REASON;
    public static final CloseReason REMOTELY_CLOSED_REASON;
    
    static {
        LOCALLY_CLOSED = new IOException("Locally closed");
        LOCALLY_CLOSED.setStackTrace(new StackTraceElement[0]);
        
        REMOTELY_CLOSED = new IOException("Remotely closed");
        REMOTELY_CLOSED.setStackTrace(new StackTraceElement[0]);

        LOCALLY_CLOSED_REASON =
                new CloseReason(org.glassfish.grizzly.CloseType.LOCALLY, LOCALLY_CLOSED);
        REMOTELY_CLOSED_REASON =
                new CloseReason(org.glassfish.grizzly.CloseType.REMOTELY, REMOTELY_CLOSED);
    }
    
    private final CloseType type;
    private final IOException cause;

    public CloseReason(final CloseType type, final IOException cause) {
        this.type = type;
        this.cause = cause != null
                ? cause
                : (type == CloseType.LOCALLY
                          ? LOCALLY_CLOSED
                          : REMOTELY_CLOSED);
    }

    /**
     * Return information whether {@link Connection} was closed locally or remotely.
     * 
     * @return information whether {@link Connection} was closed locally or remotely
     */
    public CloseType getType() {
        return type;
    }

    /**
     * Returns information about an error, that caused the {@link Connection} to
     * be closed.
     * 
     * If the cause wasn't specified by user - the default value {@link #DEFAULT_CAUSE} will be returned.
     * 
     * @return information about an error, that caused the {@link Connection} to
     * be closed
     */
    public IOException getCause() {
        return cause;
    }
}
